get /tasks

List Active Tasks (getActiveTasks)

Lists the Velostrata active management tasks.

Return type

TaskDescriptionPage

number (optional)

Integer Page number format: int32

numberOfElements (optional)

Integer Number of page elements format: int32

totalElements (optional)

Long Total number of elements format: int64

totalPages (optional)

Integer Total number of pages format: int32

_type

String

 

Enum:

TaskDescriptionPage

content (optional)

array[TaskDescription] Task description page

Velostrata management task description

additionalInfo (optional)

StringToObjectMap

endTime (optional)

Date Time task ended format: date-time

entity (optional)

EntityId

value (optional)

String Entity ID

_type

String Entity type - VM, Cloud Extension, Credentials or Task

Enum:

VmId

CloudExtensionId

CredentialsId

TaskId

errorDetails (optional)

String Task error details

errorMessage (optional)

array[String] Task error messages

id (optional)

TaskId

value (optional)

String Entity ID

_type

String Task ID

Enum:

TaskId

onPremisesTaskId (optional)

String On-premises task ID

parentTaskId (optional)

TaskId

value (optional)

String Entity ID

_type

String Task ID

Enum:

TaskId

progress (optional)

Integer Task progress format: int32

progressMessage (optional)

array[String] Progress message

startTime (optional)

Date Start time of the task format: date-time

state (optional)

TaskState

State of the task - Running, Failed, Cancelled, Succeeded, Failing or Cancelling

subTasks (optional)

array[TaskId] Sub tasks

taskType (optional)

TaskType

Task type, for example, CreateCloudExtension and RunVmInCloud

username (optional)

String User name

 

 

Example data

Content-Type: application/json

{

"number": 0,

"numberOfElements": 0,

"totalElements": 0,

"totalPages": 0,

"_type": "TaskDescriptionPage",

"content": [

{

"endTime": "2017-06-14T23:05:08.680Z",

"entity": {

"value": "vm-1",

"_type": "VmId"

},

"errorDetails": "string",

"errorMessage": [

"string"

],

"id": {

"value": "vm-1",

"_type": "TaskId"

},

"onPremisesTaskId": "task-123",

"parentTaskId": {

"value": "vm-1",

"_type": "TaskId"

},

"progress": 0,

"progressMessage": [

"string"

],

"startTime": "2017-06-14T23:05:08.680Z",

"state": "Running",

"subTasks": [

{

"value": "vm-1",

"_type": "TaskId"

}

],

"taskType": "RunVmInCloud",

"username": "velostrata_vcenetr_user"

}

]

}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK TaskDescriptionPage

Default

Error ErrorInfo

errorCode (optional)

String

url(optional)

String

message (optional)

String